Crate rend

source
Expand description

§rend

rend provides cross-platform, endian-aware primitives for Rust.

rend does not provide cross-platform alternatives for types that are inherently cross-platform, such as bool and u8. It also does not provide cross-platform alternatives for types that have an architecture-dependent size, such as isize and usize. rend does not support custom types.

rend is intended to be used to build portable types that can be shared between different architectures.

§Features

  • bytecheck: Enables support for validating types using bytecheck.

§Crates

  • zerocopy-0_8

§Example:

use core::mem::transmute;
use rend::*;

let little_int = i32_le::from_native(0x12345678);
// Internal representation is little-endian
assert_eq!(
    [0x78, 0x56, 0x34, 0x12],
    unsafe { transmute::<_, [u8; 4]>(little_int) }
);

// Can also be made with `.into()`
let little_int: i32_le = 0x12345678.into();
// Still formats correctly
assert_eq!("305419896", format!("{}", little_int));
assert_eq!("0x12345678", format!("0x{:x}", little_int));

let big_int = i32_be::from_native(0x12345678);
// Internal representation is big-endian
assert_eq!(
    [0x12, 0x34, 0x56, 0x78],
    unsafe { transmute::<_, [u8; 4]>(big_int) }
);

// Can also be made with `.into()`
let big_int: i32_be = 0x12345678.into();
// Still formats correctly
assert_eq!("305419896", format!("{}", big_int));
assert_eq!("0x12345678", format!("0x{:x}", big_int));

Modules§

  • unaligned
    Cross-platform primitives with unaligned representations.

Structs§

  • AtomicI16_be
    A big-endian AtomicI16 with a guaranteed size and alignment of 2.
  • AtomicI16_le
    A little-endian AtomicI16 with a guaranteed size and alignment of 2.
  • AtomicI32_be
    A big-endian AtomicI32 with a guaranteed size and alignment of 4.
  • AtomicI32_le
    A little-endian AtomicI32 with a guaranteed size and alignment of 4.
  • AtomicI64_be
    A big-endian AtomicI64 with a guaranteed size and alignment of 8.
  • AtomicI64_le
    A little-endian AtomicI64 with a guaranteed size and alignment of 8.
  • AtomicU16_be
    A big-endian AtomicU16 with a guaranteed size and alignment of 2.
  • AtomicU16_le
    A little-endian AtomicU16 with a guaranteed size and alignment of 2.
  • AtomicU32_be
    A big-endian AtomicU32 with a guaranteed size and alignment of 4.
  • AtomicU32_le
    A little-endian AtomicU32 with a guaranteed size and alignment of 4.
  • AtomicU64_be
    A big-endian AtomicU64 with a guaranteed size and alignment of 8.
  • AtomicU64_le
    A little-endian AtomicU64 with a guaranteed size and alignment of 8.
  • NonZeroI16_be
    A big-endian NonZeroI16 with a guaranteed size and alignment of 2.
  • NonZeroI16_le
    A little-endian NonZeroI16 with a guaranteed size and alignment of 2.
  • NonZeroI32_be
    A big-endian NonZeroI32 with a guaranteed size and alignment of 4.
  • NonZeroI32_le
    A little-endian NonZeroI32 with a guaranteed size and alignment of 4.
  • NonZeroI64_be
    A big-endian NonZeroI64 with a guaranteed size and alignment of 8.
  • NonZeroI64_le
    A little-endian NonZeroI64 with a guaranteed size and alignment of 8.
  • NonZeroI128_be
    A big-endian NonZeroI128 with a guaranteed size and alignment of 16.
  • NonZeroI128_le
    A little-endian NonZeroI128 with a guaranteed size and alignment of 16.
  • NonZeroU16_be
    A big-endian NonZeroU16 with a guaranteed size and alignment of 2.
  • NonZeroU16_le
    A little-endian NonZeroU16 with a guaranteed size and alignment of 2.
  • NonZeroU32_be
    A big-endian NonZeroU32 with a guaranteed size and alignment of 4.
  • NonZeroU32_le
    A little-endian NonZeroU32 with a guaranteed size and alignment of 4.
  • NonZeroU64_be
    A big-endian NonZeroU64 with a guaranteed size and alignment of 8.
  • NonZeroU64_le
    A little-endian NonZeroU64 with a guaranteed size and alignment of 8.
  • NonZeroU128_be
    A big-endian NonZeroU128 with a guaranteed size and alignment of 16.
  • NonZeroU128_le
    A little-endian NonZeroU128 with a guaranteed size and alignment of 16.
  • char_be
    A big-endian u32 with a guaranteed size and alignment of 4.
  • char_le
    A little-endian u32 with a guaranteed size and alignment of 4.
  • f32_be
    A big-endian f32 with a guaranteed size and alignment of 4.
  • f32_le
    A little-endian f32 with a guaranteed size and alignment of 4.
  • f64_be
    A big-endian f64 with a guaranteed size and alignment of 8.
  • f64_le
    A little-endian f64 with a guaranteed size and alignment of 8.
  • i16_be
    A big-endian i16 with a guaranteed size and alignment of 2.
  • i16_le
    A little-endian i16 with a guaranteed size and alignment of 2.
  • i32_be
    A big-endian i32 with a guaranteed size and alignment of 4.
  • i32_le
    A little-endian i32 with a guaranteed size and alignment of 4.
  • i64_be
    A big-endian i64 with a guaranteed size and alignment of 8.
  • i64_le
    A little-endian i64 with a guaranteed size and alignment of 8.
  • i128_be
    A big-endian i128 with a guaranteed size and alignment of 16.
  • i128_le
    A little-endian i128 with a guaranteed size and alignment of 16.
  • u16_be
    A big-endian u16 with a guaranteed size and alignment of 2.
  • u16_le
    A little-endian u16 with a guaranteed size and alignment of 2.
  • u32_be
    A big-endian u32 with a guaranteed size and alignment of 4.
  • u32_le
    A little-endian u32 with a guaranteed size and alignment of 4.
  • u64_be
    A big-endian u64 with a guaranteed size and alignment of 8.
  • u64_le
    A little-endian u64 with a guaranteed size and alignment of 8.
  • u128_be
    A big-endian u128 with a guaranteed size and alignment of 16.
  • u128_le
    A little-endian u128 with a guaranteed size and alignment of 16.